home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / twdoc98.zip / TWDOC98.DOC < prev    next >
Text File  |  1992-04-05  |  10KB  |  174 lines

  1. *********************************************************************
  2. *                       N O T I C E ! ! ! !                         *
  3. *  You hold in your hands a BETA copy of the Trade Wars 2002 data   *
  4. *  correction utility called the TWDoctor.  Though this version has *
  5. *  been rigorously tested, we still advise you to make complete     *
  6. *  backups of your .DAT files in the \TRADEWAR subdirectory before  *
  7. *  you attempt to use this utility.  I seriously doubt running this *
  8. *  program will do anything but good for your game's data, but a    *
  9. *  little precaution goes a long way.  Also please note that this   *
  10. *  utility is NOT free!  It is a shareware product with a $10       *
  11. *  registration fee.  Registering does not enable any more features *
  12. *  as you have the complete program in your hands, but please take  *
  13. *  the time and effort to register in appreciation of the effort    *
  14. *  that went into the making of this utility.  After all, its YOUR  *
  15. *  game that this utility will save for you. (grin)  Support the    *
  16. *  Share Ware process while its still around.                       *
  17. *                                                                   *
  18. *  Martech Software                             4-5-92              *
  19. *  134 Indian Avenue                   Registration cost = $10 U.S. *
  20. *  Lawrence, Kansas 66046                                           *
  21. ********************************************************************* 
  22.  
  23.  
  24.  
  25.  
  26. TWDoctor, a Trade Wars 2002 file correction utility.
  27. Copyright 1992, by Martech Software, Inc.  All Rights Reserved.
  28.  
  29.  
  30.         As a sysop, you're well aware of the problems that arise with running 
  31. DOS-based applications in the BBS environment.  Users can get disconnected in 
  32. the middle of processes causing corrupted files, disk write errors can dump 
  33. the whole BBS program and dozens of other un-correctable errors can put 
  34. garbage into your files and databases!
  35.  
  36.         Well here at Martech Software, we've heard the anguished cries of 
  37. harrassed Sysops who've had their Trade Wars 2002 files corrupted from the 
  38. usual BBS environment problems.  We've responded with this utility, the Trade 
  39. Wars 2002 Data Doctor.
  40.  
  41.         This utility should correct almost any data corruption problem that 
  42. can possibly occur in the DOS environment.  As long as your data files are 
  43. still there, there is hope that this utility can resurrect your ongoing TWs 
  44. game.  Though the Utility is rather self-explanatory, (a help screen will 
  45. appear if you do not enter any command-line options) here is a run down of 
  46. what each module of the TWDoctor does.
  47.  
  48.  
  49. -A  Perform All Operations.
  50.         Pretty straight-forward, this command will execute all of the other
  51.         repair modules in the Trade Wars data Doctor.  This command does
  52.         not write to a log, so you'd still need to use the -O option for
  53.         that.
  54.  
  55. -B  Resize the Tradewars data files
  56.         An odd side effect of leaving a Turbo Pascal file handle open on
  57.         a DOS based machine is that unallocated clusters can end up being
  58.         attached to the end of the actual file.  This can result in your
  59.         TWDATA.DAT file becoming HUGE!  (couple of megs or more).  The
  60.         actuall size that TWDATA.DAT should be is 214,452 bytes.  Resizing
  61.         just frees up more disk space, much like using CHKDSK /F to recover
  62.         lost clusters.  The file SHIPFILE.DAT is also resized with this
  63.         command to its proper size of 17,480 bytes.
  64.  
  65. -Cx  Reset the game date
  66.         This module will globally reset the date in TW2002.  Have you ever
  67.         accidently set the date wrong on your BBS?  After someone enters 
  68.         TW2002, the game dates are updated to reflect the PC's date.  When
  69.         you discover your problem and put the date back, the TW2002 dates
  70.         are then all wrong.  This can cause effects like everyone being
  71.         locked out of the game for xxxxx days (date was accidently moved to
  72.         the future, then back) or things like planets dying out from 
  73.         over production (date was moved to the past and then back).  This
  74.         function will globally move through the Trade Wars databases and
  75.         reset all activity dates to YESTERDAY (one day less than the current
  76.         date in the PC's CMOS setup).  Also, you may optionally specify the
  77.         number of days back you'd like the date set to, from 1 to 100 in the
  78.         format of just calling this option like:   -C25   (set for 25 days
  79.         back, ports and planets will have had unmolested production for
  80.         25 full days).
  81.  
  82. -D   Invalid Pointers (error 100s with abnormal ends)
  83.         From time to time, pointers within the database can get corrupted from
  84.         the previously mentioned DOS errors and end up pointing into
  85.         never-never land.  This module will assure that they are all valid
  86.         and should stop the occurance of the game kicking users back out
  87.         to the BBS with an "Error Code 100"
  88.  
  89. -E   Invalid Reals (error 2xxs with abnormal ends)
  90.         Reals can also get corrupted within the game and cause abnormal ends.
  91.         (The user gets kicked back to the BBS with an "Error Code 2xx")
  92.         Use this module to correct such problems.
  93.  
  94. -Ofilename   Log the TWDoctor run to a filename
  95.                 Specifying the -O option followed by a legitimate DOS file
  96.                 name (no space between O and the filename) will log the 
  97.                 entirety of the run to a text file of your choice.  You can
  98.                 use the TWDoctor as a part of your nightly maintenance 
  99.                 batch runs and use the logging function to view the results.
  100.                 If you specify a filename that already exists, the TWDoctor
  101.                 will append this run's results onto the end of that file.
  102.  
  103. -P   Repair Players
  104.         Now we're getting down the the core modules.  This function cleans
  105.         garbage out of the Player's name and BBS name.  It insures that these
  106.         names are within length limits imposed by the game.  It then checks
  107.         and fixes any negative values or over the limit values it encounters
  108.         in the player's records.  I won't go into detail on what this module
  109.         does, but suffice it to say that its many pages of code.
  110.  
  111. -S   Repair Sectors
  112.         Like the Repair Players function above, this module cleans and trims
  113.         the Sector nebulae names and beacons that are invalid.  It sorts
  114.         the warps out of the sector in ascending order and removes any 
  115.         duplicate warps that it finds.  Invalid warplanes are removed.
  116.         All other sector values are validated.
  117.  
  118. -T   Repair Ports
  119.         Besides cleaning and trimming Port names and LastShip docked names,
  120.         this module also does major validation on the specifications of each
  121.         port.  This module RECREATES Sol, Alpha Centuari, Rylos and
  122.         StarGate Alpha 1 if they have been corrupted or destroyed.  All
  123.         Port Types are checked to insure that they accurately reflect what
  124.         type each port is and all production and inventory values are 
  125.         repaired if needed.  The ports will also be restocked and will appear
  126.         as if they've been unmolested for twenty days, enough to regenerate
  127.         all onhand amounts to maximum.  Obviously, you would NOT want to 
  128.         run this module every night as much of the strategy in TW2002 is
  129.         finding and defending a good set of ports.  If each port was fully
  130.         regenerated each night, it would make it just too damn easy to play. 
  131.         (grin)
  132.  
  133. -N   Repair Planets
  134.         Planet names and owners will be cleaned and trimmed.  All onhand 
  135.         amounts will be validated, production levels adjusted and invalid
  136.         construction days/types will be fixed.
  137.  
  138. -F   Repair Ferrengi
  139.         Names and shipnames will be cleaned and trimmed.  Invalid values
  140.         will be reset, and if the file itself (FERRENGI.DAT) is missing,
  141.         it will be rebuilt from scratch.
  142.  
  143. -A   Repair Aliens
  144.         This module is virtually identical to the Ferrengi module with the
  145.         exception being that the filename involved is (ALIENS.DAT)
  146.  
  147.  
  148.  
  149.  
  150.  
  151.         There are bound to be some problems yet that this utility cannot 
  152. correct, but as they are encountered, we will release subsequent versions to 
  153. handle those problems.  Should you find a problem that the TWDoctor cannot 
  154. fix, zip up your *.DAT files in the /TRADEWAR subdir and upload it to Sysop
  155. on Castle RavenLoft (913) 842-0300 and (913) 832-0248.  Please verify that you
  156. have the LATEST release of the TWDoctor before you do this as your problem may
  157. have already been added to the capabilities of the TWDoctor.
  158.  
  159.         As far as I know, the TWDoctor is a unique offering from ANY shareware 
  160. author.  Many authors put out bug fixes, but we decided to follow the approach 
  161. of Peter Norton in offering a chance to recover your data instead of just 
  162. scrapping it and starting all over.  This utility has been a challenge to 
  163. write and will be continually updated as long as problem reports come in that 
  164. it can't handle.  So please show your support for our efforts by registering 
  165. this product!  Registration is only Ten Dollars U.S.   If you know that you do 
  166. not have the latest version of the TWDoctor, include an additional $5 and we 
  167. will mail it to you on your choice of low density diskette.  
  168.  
  169. Martech Software, Inc.
  170. 134 Indian Ave.
  171. Lawrence, Kansas 66046
  172.  
  173.  
  174.